home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 090 / pcprompt.arc / HELP.DOC < prev    next >
Encoding:
Text File  |  1986-05-16  |  21.8 KB  |  587 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                           PC-prompt USER'S GUIDE
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                            Lake Medici Software
  17.                            17 Medici Court
  18.                            Baltimore, MD  21234
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.                  Copyright (c) 1985,1986  Anthony J. Spuria
  28.  
  29.                          All rights reserved
  30.  
  31.  
  32.  
  33.   
  34.  
  35.  
  36.  
  37.           CONTENTS                                            PAGE
  38.  
  39.  
  40.  
  41.           Introduction ..........................................1
  42.  
  43.           Installation ..........................................2
  44.  
  45.           Starting PC-prompt ....................................3
  46.  
  47.           Using PC-prompt .......................................4
  48.  
  49.           Stopping PC-prompt ....................................5
  50.  
  51.           PROMPT Command Considerations .........................6
  52.  
  53.           In Case of Trouble ....................................7
  54.  
  55.           Appendix A -- Using an AUTOEXEC.BAT file ..............8
  56.  
  57.           Appendix B -- A Sneak Preview ........................10
  58.  
  59.           Appendix C -- User Supported Software and Licensing...11
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                             Introduction
  68.  
  69.  
  70.  
  71.  
  72.           PC-prompt is a unique memory-resident help utility for
  73.           the IBM PC, XT, AT, and compatibles.  It looks for DOS
  74.           commands as you type them and automatically displays
  75.           their syntax definitions in inverse video on the last
  76.           line of your monitor screen.
  77.  
  78.           Pressing the F10 function key instantly displays a
  79.           help window for the command being entered.  This
  80.           window overlays whatever information was on the first
  81.           23 lines of the screen.  The command being typed still
  82.           shows on line 24, and the proper format for the
  83.           command is still displayed on the last line.
  84.  
  85.           You can leave the help window on the screen as you
  86.           finish typing the command, or you can press the F10
  87.           key again to return to your previous display.  Leaving
  88.           the help screen activated lets you finish entering the
  89.           command while you can still see examples of its use
  90.           and descriptions of its parameters and options.  In
  91.           either case, the command syntax remains on the last
  92.           line as a reference.  If the help window is still
  93.           active when you press the Enter key, it will
  94.           automatically be replaced by your original screen
  95.           before the command is executed.
  96.  
  97.           Pressing the F10 key while at the DOS command level
  98.           calls up a help window which lists most of the
  99.           commonly used DOS commands.  You can toggle back and
  100.           forth at will between this window and your previous
  101.           display by pressing the F10 key.
  102.  
  103.           Since PC-prompt is memory-resident, it stays loaded in
  104.           memory until you reboot the PC.  It automatically
  105.           activates when DOS reaches the command level, and
  106.           deactivates whenever you execute any DOS command,
  107.           Batch file, or program.  Because of this, it is
  108.           compatible with most software, even with programs
  109.           which do direct screen memory operations without using
  110.           DOS.  It is even compatible with various other
  111.           memory-resident programs such as RAM Drive emulators,
  112.           printer spoolers, and even Borland's SideKick.
  113.         
  114.           If you can't wait to see PC-prompt in action, jump
  115.           ahead to Appendix B -- A SNEAK PREVIEW.  However,
  116.           be sure to come back and read the rest of this
  117.           User's Guide as soon as you have sampled PC-prompt
  118.           in action.
  119.  
  120.                                                           1
  121.  
  122.  
  123.  
  124.  
  125.                          PC-prompt INSTALLATION
  126.  
  127.  
  128.         
  129.           PC-prompt has two modes of operation.  The Full-Help
  130.           mode operates as described in the introduction.  The
  131.           current version of PC-prompt requires about 32K
  132.           bytes of memory for this mode.  If this leaves you
  133.           without enough memory for some particular application,
  134.           you can still get the pop-up command syntax
  135.           descriptions by selecting the Prompts-Only mode of
  136.           operation.  This mode uses less than 14K bytes of
  137.           memory.
  138.  
  139.           The Full-Help mode requires the files:
  140.           
  141.                          HELP.EXE
  142.                          HELPF.CMP
  143.                          HELPPOPF.CMP
  144.                          HELPCMDF.NCP
  145.                          HELPTABF.NCP
  146.  
  147.           The Prompts-Only mode requires the files:
  148.  
  149.                          HELP.EXE
  150.                          HELPP.CMP
  151.                          HELPPOPP.CMP
  152.                          HELPCMDP.NCP
  153.                          HELPTABP.NCP
  154.  
  155.           For convenience you can copy all files required for
  156.           the mode(s) you intend to use onto your boot disk.  You only
  157.           need these files to start PC-prompt after you boot
  158.           your computer, so it is not actually necessary to keep
  159.           them on your system disk.  However, this allows you to
  160.           automatically invoke PC-prompt with an AUTOEXEC.BAT
  161.           command file.  See Appendix A for further information
  162.           about using an AUTOEXEC.BAT file.
  163.           
  164.                                                             2
  165.  
  166.  
  167.         
  168.                          STARTING PC-prompt
  169.  
  170.         
  171.         
  172.           All of the required HELP files must be in the default drive
  173.           (and subdirectory) when you start PC-prompt.  The default
  174.           drive can be set by entering its drive letter followed by a
  175.           colon and then pressing the Enter key.  For example, if the
  176.           files are on drive A, issue the command:
  177.  
  178.                          A:
  179.  
  180.           and press Enter.  If the files are in a subdirectory, use
  181.           the CHDIR command to change to this directory.  For
  182.           example, if the files are in a subdirectory named "HELP"
  183.           just below the root level on drive A, issue the command:
  184.  
  185.                          CHDIR \HELP
  186.  
  187.           and press Enter.
  188.  
  189.           After you have set the default drive (and subdirectory),
  190.           issue the command:
  191.  
  192.                          HELP
  193.  
  194.           and press Enter.
  195.  
  196.           The PC-prompt disk can be removed after the program has
  197.           initialized itself; it is not needed again unless you
  198.           reboot.
  199.  
  200.           When you start PC-prompt, it lets you select either the
  201.           "Full-Help" or "Prompts-Only" operating mode.  As an
  202.           option, you can make this selection when you start
  203.           PC-prompt by appending an F (for Full-Help) or P (for
  204.           Prompts-Only) on the command line as follows:
  205.         
  206.                          HELP F
  207.         
  208.           or
  209.  
  210.                          HELP P
  211.  
  212.           By doing this you avoid having PC-prompt explain your
  213.           options and request your selection.  This makes it possible
  214.           to start PC-prompt automatically each time you boot your
  215.           PC.  To do this, simply put the HELP F or HELP P command in
  216.           your AUTOEXEC.BAT command file.  See Appendix A for
  217.           information about using an AUTOEXEC.BAT command file.
  218.  
  219.                                                                  3
  220.  
  221.  
  222.  
  223.  
  224.                        USING PC-prompt
  225.  
  226.         
  227.         
  228.           PC-prompt uses the last line of the display as a
  229.           prompt line.  When it first recognizes the standard
  230.           DOS command prompt (for example, A> ), it explains
  231.           that you can get a list of DOS commands by pressing
  232.           the F10 function key.  Try it.  Press F10 again to
  233.           restore your old screen.  You can toggle back and
  234.           forth between the current PC-prompt help screen and
  235.           your normal screen whenever DOS is waiting for you
  236.           to enter a command.
  237.         
  238.           Once PC-prompt has been started, it continually
  239.           monitors keyboard input and screen output made using
  240.           the standard DOS console device handler CON.  When it
  241.           recognizes a DOS command, it automatically prompts on
  242.           the bottom line of the screen with the general format
  243.           for that command.  This may be all you need, but if
  244.           you have selected the Full-Help mode and you want more
  245.           help just press the F10 function key.  A pop-up help
  246.           window for the command will appear giving examples of
  247.           its use and describing any parameters or options it
  248.           may have.  You can continue typing the command while
  249.           the help screen is still being displayed, or you can
  250.           press the F10 key again to restore your old screen
  251.           before you continue.  If you leave the help window on
  252.           the screen, PC-prompt will automatically restore your
  253.           previous screen when you press Enter.
  254.         
  255.           Although PC-prompt is mainly an aid for using DOS at
  256.           the command level, it also provides help while you are
  257.           using BASIC, DEBUG, EDLIN or Borland's Turbo Pascal
  258.           editor.  Within these programs you can toggle back and
  259.           forth between the help screen and your normal screen
  260.           by pressing Shift-Alt-F10 (press and hold Shift and
  261.           Alt keys, then press F10).  This three-key "hot key"
  262.           combination is used to prevent accidentally interfering
  263.           with programs which use the function keys alone or with
  264.           the control, shift or alt key.
  265.  
  266.                                                               4
  267.  
  268.           When PC-prompt is activated within one of these
  269.           programs, Shift-Alt-F10 can be used to restore your
  270.           normal display screen.  Since BASIC and the Turbo
  271.           Pascal editor sidestep the standard DOS keyboard and
  272.           screen routines, you should restore you screen before
  273.           typing any command within these pregrams.  When using
  274.           DEBUG or EDLIN, however, you can use the automatic
  275.           screen restoration that takes place when you press
  276.           Enter.
  277.  
  278.           Note also that help for Turbo Pascal applies only
  279.           within the editor portion of this program.  DO NOT
  280.           press Shift-Alt-F10 within other portions of this
  281.           program or you will exit back to DOS without saving
  282.           your work.
  283.  
  284.  
  285.  
  286.  
  287.                            STOPPING PC-prompt
  288.  
  289.  
  290.           PC-prompt can be temporarily disabled by changing
  291.           the DOS command prompt as described below under
  292.           "Prompt Command Considerations".  In order to recover
  293.           the memory it uses, however, you must reboot by
  294.           pressing Ctrl-Alt-Del.  If you started PC-prompt with
  295.           an AUTOEXEC.BAT file, you can either:
  296.  
  297.           1.  Modify AUTOEXEC.BAT to remove the HELP F or HELP P
  298.               command.
  299.  
  300.           or
  301.  
  302.           2.  Rename AUTOEXEC.BAT to another name so that it
  303.               will not be executed when you reboot.
  304.           
  305.           You MUST do something of this sort before you reboot
  306.           or PC-prompt will just be automatically restarted.
  307.  
  308.  
  309.  
  310.                                                         5
  311.  
  312.  
  313.                     PROMPT COMMAND CONSIDERATIONS
  314.  
  315.         
  316.         
  317.           PC-prompt monitors all DOS operating system output to
  318.           the screen and looks for the normal A> ( or B> or C> )
  319.           command prompt.  If you have changed this standard
  320.           prompt with the
  321.              
  322.             PROMPT [prompt-text]
  323.         
  324.           command, either manually or in an AUTOEXEC.BAT file, it
  325.           won't find this and won't do its automatic command
  326.           prompting.  You can correct this situation by reissuing
  327.           the PROMPT command without any prompt-text parameter. 
  328.           You can use this PROMPT command with and without the
  329.           prompt-text if you ever want to temporarily disable and
  330.           enable PC-prompt.  If you want to modify the command
  331.           prompt and still keep PC-prompt active, you must follow
  332.           one simple rule:
  333.  
  334.           The last characters in the prompt-text MUST be
  335.  
  336.                         $_$n$g
  337.  
  338.           These are special meta-characters used by the PROMPT
  339.           command which function as follows:
  340.  
  341.           $_  returns the cursor to the start of the next line
  342.           $n  is replaced by the default drive letter
  343.           $g  is replaced by the ">" symbol
  344.  
  345.  
  346.  
  347.  
  348.  
  349.           These meta-characters must be entered exactly as
  350.           shown, in lower case with no spaces between them.
  351.  
  352.           A commonly used prompt command which shows your
  353.           current default drive and subdirectory is:
  354.  
  355.                        PROMPT $p
  356.  
  357.           This command temporarily disables PC-prompt.  You can
  358.           reenable it either by issuing the PROMPT command with
  359.           no prompt-text, or by entering the command:
  360.  
  361.                        PROMPT $p$_$n$g
  362.  
  363.           This command displays your default drive and
  364.           subdirectory on one line, followed by the normal DOS
  365.           prompt on the next line.
  366.  
  367.                                                             6
  368.  
  369.  
  370.  
  371.                     IN CASE OF TROUBLE
  372.  
  373.         
  374.         
  375.           If PC-prompt ever stops working, issue the command:
  376.         
  377.                       PROMPT
  378.         
  379.           with no parameters.  This will restore the standard
  380.           DOS command prompt if it has been changed.  See the
  381.           section "PROMPT COMMAND CONSIDERATIONS" for more
  382.           details about using the PROMPT command in conjunction
  383.           with PC-prompt.
  384.         
  385.           If you have restored the normal DOS command prompt but PC-prompt
  386.           is still not working, it may be necessary to change the
  387.           order in which you install memory resident software in
  388.           your system.  For example, RAM disk emulators often
  389.           must be loaded before any other resident software. 
  390.           Other programs like BORLAND's SIDEKICK, for example,
  391.           want to be the last resident programs loaded.  Try
  392.           starting memory resident programs in another order to
  393.           see what works best in your particular situation.  In
  394.           some cases you may have to choose between PC-prompt and
  395.           some other program if the two are not compatible.
  396.  
  397.  
  398.                                                            7
  399.  
  400.  
  401.                   APPENDIX A -- USING AUTOEXEC.BAT FILE
  402.  
  403.  
  404.           In its simplest form, a batch file is just a text file
  405.           with DOS commands on each line.  When the batch file
  406.           is invoked, these commands are executed one by one. 
  407.           AUTOEXEC.BAT is a special batch command file that is
  408.           invoked automatically whenever you boot your PC.  If
  409.           you don't have such a file, you can create one using
  410.           EDLIN or any other text editor that produces pure
  411.           ASCII text files.
  412.  
  413.           Another way to create an AUTOEXEC.BAT file is to issue
  414.           the command:
  415.  
  416.                          COPY CON: AUTOEXEC.BAT
  417.  
  418.           and press Enter.  Each line you now type will be
  419.           copied into a new file called AUTOEXEC.BAT.  You can
  420.           use the cursor keys, Ins key, Del key, etc.  to
  421.           correct any typing errors before you press the Enter
  422.           key.  When you do press the Enter key, the command
  423.           line you have typed will be added to the file.  When
  424.           you have finished entering all desired DOS command
  425.           lines into this file, end the file creation operation
  426.           by pressing the F6 function key and then pressing
  427.           Enter.
  428.  
  429.           Alternatively, you can use a batch file named
  430.           AUTOEXEC.BAT which is on your PC-prompt Working Disk. 
  431.           If you have a two drive system, you can copy the
  432.           AUTOEXEC.BAT file onto your boot disk by putting the
  433.           PC-prompt Working Disk in drive B and your boot disk
  434.           in drive A and issuing the command:
  435.  
  436.                          COPY B:AUTOEXEC.BAT A:
  437.  
  438.           For a one drive system, you can put the PC-prompt
  439.           Working Disk in drive A and issue the command:
  440.  
  441.                          COPY A:AUTOEXEC.BAT B:
  442.  
  443.           When told to insert the diskette for drive B, remove
  444.           the PC-prompt Working Disk, insert your boot disk back
  445.           into the single drive, and press the space bar.
  446.  
  447.  
  448.  
  449.                                                               8
  450.  
  451.  
  452.  
  453.  
  454.  
  455.           If you already have an AUTOEXEC.BAT command file,
  456.           you can use EDLIN to add either the command:
  457.         
  458.                               HELP F
  459.  
  460.           or
  461.  
  462.                               HELP P
  463.         
  464.           to it.  If you omit the F or P you will have to make
  465.           this selection each time you boot.
  466.  
  467.  
  468.  
  469.  
  470.  
  471.           Remember that the required HELP files must all be in
  472.           the default drive (and subdirectory) when PC-prompt is
  473.           started.  If necessary, insert commands into the
  474.           AUTOEXEC.BAT file to assure that these defaults are set
  475.           correctly as described in the section "Starting
  476.           PC-prompt".
  477.  
  478.  
  479.  
  480.                                                               9
  481.  
  482.                  APPENDIX B -- A SNEAK PREVIEW
  483.  
  484.  
  485.  
  486.           This appendix explains how to get a sneak preview of
  487.           PC-prompt in action even before reading the rest of
  488.           this User's Guide.  If you feel uncomfortable with the
  489.           level of explanation given here, then you should
  490.           probably go back and read the details given above.  If
  491.           you do feel comfortable, however, then jump right in
  492.           and get started.
  493.  
  494.           If you have an AUTOEXEC.BAT file, temporarily rename
  495.           it to AUTOEXEC.TMP.  Next, reboot
  496.           your PC (Ctrl-Alt-Del).  Then put your PC-prompt
  497.           diskette into a drive and set that drive as the
  498.           default.  Now issue the command:
  499.  
  500.                             HELP
  501.  
  502.           and read the selection information.  Just press Enter
  503.           to select the Full-Help mode of operation.
  504.  
  505.           When the help prompt appears on the bottom of your
  506.           monitor screen, press the F10 function key.  This
  507.           displays a window listing DOS commands and explaining
  508.           briefly the pop-up command formats.  Press F10 a few
  509.           times and watch the screen toggle between the help
  510.           window and your previous display.  Type a command like
  511.           DIR, but before pressing Enter, press the F10 key. 
  512.           Note that PC-prompt has recognized the command and
  513.           displays the appropriate help window for it.  Note
  514.           also that the general command syntax definition
  515.           appears in inverse video on the last line of your
  516.           screen.  
  517.  
  518.           After you have finished sampling how PC-prompt works,
  519.           rename AUTOEXEC.TMP back to AUTOEXEC.BAT.  Be sure to read the
  520.           rest of this User's Guide to get the maximum benefit
  521.           out of PC-prompt.
  522.  
  523.  
  524.  
  525.                                                          10
  526.  
  527.  
  528.           APPENDIX C -- USER SUPPORTED SOFTWARE and LICENSING TERMS
  529.  
  530.  
  531.           PC-prompt is not public domain software, it is a copyrighted
  532.           program distributed by Lake Medici Software.  You are hereby
  533.           granted a limited license to use PC-prompt, and to copy it and
  534.           further distribute it, under the following conditions:
  535.  
  536.           1) No fee may be charged for such copying and distribution.
  537.  
  538.           2) PC-prompt may ONLY be distributed in its original state,
  539.              without any modifications or changes to the program itself
  540.              or to any of its data files.
  541.  
  542.           3) Use by commercial or governmental organizations must be limited
  543.              to a reasonable time (e.g. about a month) for evaluation
  544.              purposes only, after which time a $20 per copy (per machine)
  545.              price must be paid to
  546.  
  547.                           LAKE MEDICI SOFTWARE
  548.                             17 Medici Court
  549.                           Baltimore, MD  21234
  550.  
  551.              (Print the file HELP.INV if your organization requires an
  552.               invoice to make this payment.)
  553.  
  554.           4) The per-copy (per machine) price for commercial and governmental
  555.              organizations at one site reduces with volume as follows:
  556.  
  557.                  Copy Number                    Per-Copy Price
  558.  
  559.                   1 - 5                                $20
  560.                   6 - 10                               $15
  561.                   11 - 25                              $10
  562.                   26 - 100                             $7
  563.                   101 - infinite                       $5
  564.  
  565.           5) Backup copies may be made as required for safe operational
  566.              practice, but not to circumvent payments.
  567.  
  568.           6) We would greatly appreciate a small contribution of $10
  569.              from personal (non-business) users to help support future
  570.              development.
  571.  
  572.           User supported software (sometimes called freeware or shareware)
  573.           attempts to provide useful programs to the PC community at low
  574.           cost by reducing the dependence on conventional marketing channels.
  575.           Several software developers have proven that the concept works, to
  576.           the mutual benefit of the independent program authors and the
  577.           PC community itself.
  578.  
  579.           The user benefits by the availability of low cost software which
  580.           he can evaluate on his own system before making the decision to
  581.           purchase it.  The author benefits by being able to enter the
  582.           software market without extensive monetary risks.  The user
  583.           community determines which products succeed based on their true
  584.           utility, rather than on their marketing achievements.
  585.  
  586.                                                                 11
  587.